<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class URLField</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class URLField</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">URLField</p>
<p class="description"><p>A text field that only accepts a reasonably-formatted URL. Supports HTTP(S)  and FTP. If a value is missing the HTTP(S)/FTP prefix, adds it to the final  value.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeff Ober</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">1005</span>)
		</p>
		
				
		<pre><a href="../Fields/PhormField.html">PhormField</a>
   |
   --<a href="../Fields/TextField.html">TextField</a>
      |
      --URLField</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#prepare_value" title="details" class="method-name">prepare_value</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#validate" title="details" class="method-name">validate</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/TextField.html#var$max_length">TextField::$max_length</a></span><br>
							</span>
											</blockquote> 
									<p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodprepare_value" id="prepare_value"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">prepare_value</span> (line <span class="line-number">1013</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prepares the value by inserting http:// to the beginning if missing.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeff Ober</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			prepare_value
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></dt>
						<dd>Pre-processes a value for validation, handling magic quotes if used.</dd>
					</dl>
			
	</div>
<a name="methodvalidate" id="validate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">validate</span> (line <span class="line-number">1028</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Validates the the value is a valid URL (mostly).</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeff Ober</li>
				<li><span class="field">throws:</span> ValidationError</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			validate
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></dt>
						<dd>Validates that the value is less than $this-&gt;max_length;</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Fields/TextField.html#method__construct">TextField::__construct()</a></span><br>
													<span class="method-name"><a href="../Fields/TextField.html#methodget_widget">TextField::get_widget()</a></span><br>
													<span class="method-name"><a href="../Fields/TextField.html#methodimport_value">TextField::import_value()</a></span><br>
													<span class="method-name"><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></span><br>
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
													<span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Mon, 20 Apr 2009 08:29:24 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>